<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span><a name="line.2"></a>
<span class="sourceLineNo">003</span>  Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.3"></a>
<span class="sourceLineNo">004</span>  contributor license agreements.  See the NOTICE file distributed with<a name="line.4"></a>
<span class="sourceLineNo">005</span>  this work for additional information regarding copyright ownership.<a name="line.5"></a>
<span class="sourceLineNo">006</span>  The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.6"></a>
<span class="sourceLineNo">007</span>  (the "License"); you may not use this file except in compliance with<a name="line.7"></a>
<span class="sourceLineNo">008</span>  the License.  You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>      http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span><a name="line.11"></a>
<span class="sourceLineNo">012</span>   Unless required by applicable law or agreed to in writing, software<a name="line.12"></a>
<span class="sourceLineNo">013</span>   distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a>
<span class="sourceLineNo">014</span>   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a>
<span class="sourceLineNo">015</span>   See the License for the specific language governing permissions and<a name="line.15"></a>
<span class="sourceLineNo">016</span>   limitations under the License.<a name="line.16"></a>
<span class="sourceLineNo">017</span> */<a name="line.17"></a>
<span class="sourceLineNo">018</span>package org.apache.commons.dbcp2.managed;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.lang.ref.WeakReference;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.sql.Connection;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.sql.SQLException;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.Objects;<a name="line.23"></a>
<span class="sourceLineNo">024</span><a name="line.24"></a>
<span class="sourceLineNo">025</span>import javax.transaction.RollbackException;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import javax.transaction.Status;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import javax.transaction.Synchronization;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import javax.transaction.SystemException;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import javax.transaction.Transaction;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import javax.transaction.TransactionSynchronizationRegistry;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import javax.transaction.xa.XAResource;<a name="line.31"></a>
<span class="sourceLineNo">032</span><a name="line.32"></a>
<span class="sourceLineNo">033</span>/**<a name="line.33"></a>
<span class="sourceLineNo">034</span> * TransactionContext represents the association between a single XAConnectionFactory and a Transaction. This context<a name="line.34"></a>
<span class="sourceLineNo">035</span> * contains a single shared connection which should be used by all ManagedConnections for the XAConnectionFactory, the<a name="line.35"></a>
<span class="sourceLineNo">036</span> * ability to listen for the transaction completion event, and a method to check the status of the transaction.<a name="line.36"></a>
<span class="sourceLineNo">037</span> *<a name="line.37"></a>
<span class="sourceLineNo">038</span> * @since 2.0<a name="line.38"></a>
<span class="sourceLineNo">039</span> */<a name="line.39"></a>
<span class="sourceLineNo">040</span>public class TransactionContext {<a name="line.40"></a>
<span class="sourceLineNo">041</span>    private final TransactionRegistry transactionRegistry;<a name="line.41"></a>
<span class="sourceLineNo">042</span>    private final WeakReference&lt;Transaction&gt; transactionRef;<a name="line.42"></a>
<span class="sourceLineNo">043</span>    private final TransactionSynchronizationRegistry transactionSynchronizationRegistry;<a name="line.43"></a>
<span class="sourceLineNo">044</span>    private Connection sharedConnection;<a name="line.44"></a>
<span class="sourceLineNo">045</span>    private boolean transactionComplete;<a name="line.45"></a>
<span class="sourceLineNo">046</span><a name="line.46"></a>
<span class="sourceLineNo">047</span>    /**<a name="line.47"></a>
<span class="sourceLineNo">048</span>     * Provided for backwards compatibility<a name="line.48"></a>
<span class="sourceLineNo">049</span>     *<a name="line.49"></a>
<span class="sourceLineNo">050</span>     * @param transactionRegistry the TransactionRegistry used to obtain the XAResource for the<a name="line.50"></a>
<span class="sourceLineNo">051</span>     * shared connection<a name="line.51"></a>
<span class="sourceLineNo">052</span>     * @param transaction the transaction<a name="line.52"></a>
<span class="sourceLineNo">053</span>     */<a name="line.53"></a>
<span class="sourceLineNo">054</span>    public TransactionContext(final TransactionRegistry transactionRegistry, final Transaction transaction) {<a name="line.54"></a>
<span class="sourceLineNo">055</span>        this (transactionRegistry, transaction, null);<a name="line.55"></a>
<span class="sourceLineNo">056</span>    }<a name="line.56"></a>
<span class="sourceLineNo">057</span><a name="line.57"></a>
<span class="sourceLineNo">058</span>    /**<a name="line.58"></a>
<span class="sourceLineNo">059</span>     * Creates a TransactionContext for the specified Transaction and TransactionRegistry. The TransactionRegistry is<a name="line.59"></a>
<span class="sourceLineNo">060</span>     * used to obtain the XAResource for the shared connection when it is enlisted in the transaction.<a name="line.60"></a>
<span class="sourceLineNo">061</span>     *<a name="line.61"></a>
<span class="sourceLineNo">062</span>     * @param transactionRegistry<a name="line.62"></a>
<span class="sourceLineNo">063</span>     *            the TransactionRegistry used to obtain the XAResource for the shared connection<a name="line.63"></a>
<span class="sourceLineNo">064</span>     * @param transaction<a name="line.64"></a>
<span class="sourceLineNo">065</span>     *            the transaction<a name="line.65"></a>
<span class="sourceLineNo">066</span>     * @param transactionSynchronizationRegistry<a name="line.66"></a>
<span class="sourceLineNo">067</span>     *              The optional TSR to register synchronizations with<a name="line.67"></a>
<span class="sourceLineNo">068</span>     * @since 2.6.0<a name="line.68"></a>
<span class="sourceLineNo">069</span>     */<a name="line.69"></a>
<span class="sourceLineNo">070</span>    public TransactionContext(final TransactionRegistry transactionRegistry, final Transaction transaction,<a name="line.70"></a>
<span class="sourceLineNo">071</span>                              final TransactionSynchronizationRegistry transactionSynchronizationRegistry) {<a name="line.71"></a>
<span class="sourceLineNo">072</span>        Objects.requireNonNull(transactionRegistry, "transactionRegistry is null");<a name="line.72"></a>
<span class="sourceLineNo">073</span>        Objects.requireNonNull(transaction, "transaction is null");<a name="line.73"></a>
<span class="sourceLineNo">074</span>        this.transactionRegistry = transactionRegistry;<a name="line.74"></a>
<span class="sourceLineNo">075</span>        this.transactionRef = new WeakReference&lt;&gt;(transaction);<a name="line.75"></a>
<span class="sourceLineNo">076</span>        this.transactionComplete = false;<a name="line.76"></a>
<span class="sourceLineNo">077</span>        this.transactionSynchronizationRegistry = transactionSynchronizationRegistry;<a name="line.77"></a>
<span class="sourceLineNo">078</span>    }<a name="line.78"></a>
<span class="sourceLineNo">079</span><a name="line.79"></a>
<span class="sourceLineNo">080</span>    /**<a name="line.80"></a>
<span class="sourceLineNo">081</span>     * Adds a listener for transaction completion events.<a name="line.81"></a>
<span class="sourceLineNo">082</span>     *<a name="line.82"></a>
<span class="sourceLineNo">083</span>     * @param listener<a name="line.83"></a>
<span class="sourceLineNo">084</span>     *            the listener to add<a name="line.84"></a>
<span class="sourceLineNo">085</span>     * @throws SQLException<a name="line.85"></a>
<span class="sourceLineNo">086</span>     *             if a problem occurs adding the listener to the transaction<a name="line.86"></a>
<span class="sourceLineNo">087</span>     */<a name="line.87"></a>
<span class="sourceLineNo">088</span>    public void addTransactionContextListener(final TransactionContextListener listener) throws SQLException {<a name="line.88"></a>
<span class="sourceLineNo">089</span>        try {<a name="line.89"></a>
<span class="sourceLineNo">090</span>            if (!isActive()) {<a name="line.90"></a>
<span class="sourceLineNo">091</span>                final Transaction transaction = this.transactionRef.get();<a name="line.91"></a>
<span class="sourceLineNo">092</span>                listener.afterCompletion(TransactionContext.this,<a name="line.92"></a>
<span class="sourceLineNo">093</span>                        transaction != null &amp;&amp; transaction.getStatus() == Status.STATUS_COMMITTED);<a name="line.93"></a>
<span class="sourceLineNo">094</span>                return;<a name="line.94"></a>
<span class="sourceLineNo">095</span>            }<a name="line.95"></a>
<span class="sourceLineNo">096</span>            final Synchronization s = new Synchronization() {<a name="line.96"></a>
<span class="sourceLineNo">097</span>                @Override<a name="line.97"></a>
<span class="sourceLineNo">098</span>                public void afterCompletion(final int status) {<a name="line.98"></a>
<span class="sourceLineNo">099</span>                    listener.afterCompletion(TransactionContext.this, status == Status.STATUS_COMMITTED);<a name="line.99"></a>
<span class="sourceLineNo">100</span>                }<a name="line.100"></a>
<span class="sourceLineNo">101</span><a name="line.101"></a>
<span class="sourceLineNo">102</span>                @Override<a name="line.102"></a>
<span class="sourceLineNo">103</span>                public void beforeCompletion() {<a name="line.103"></a>
<span class="sourceLineNo">104</span>                    // empty<a name="line.104"></a>
<span class="sourceLineNo">105</span>                }<a name="line.105"></a>
<span class="sourceLineNo">106</span>            };<a name="line.106"></a>
<span class="sourceLineNo">107</span>            if (transactionSynchronizationRegistry != null) {<a name="line.107"></a>
<span class="sourceLineNo">108</span>                transactionSynchronizationRegistry.registerInterposedSynchronization(s);<a name="line.108"></a>
<span class="sourceLineNo">109</span>            } else {<a name="line.109"></a>
<span class="sourceLineNo">110</span>                getTransaction().registerSynchronization(s);<a name="line.110"></a>
<span class="sourceLineNo">111</span>            }<a name="line.111"></a>
<span class="sourceLineNo">112</span>        } catch (final RollbackException e) {<a name="line.112"></a>
<span class="sourceLineNo">113</span>            // JTA spec doesn't let us register with a transaction marked rollback only<a name="line.113"></a>
<span class="sourceLineNo">114</span>            // just ignore this and the tx state will be cleared another way.<a name="line.114"></a>
<span class="sourceLineNo">115</span>        } catch (final Exception e) {<a name="line.115"></a>
<span class="sourceLineNo">116</span>            throw new SQLException("Unable to register transaction context listener", e);<a name="line.116"></a>
<span class="sourceLineNo">117</span>        }<a name="line.117"></a>
<span class="sourceLineNo">118</span>    }<a name="line.118"></a>
<span class="sourceLineNo">119</span><a name="line.119"></a>
<span class="sourceLineNo">120</span>    /**<a name="line.120"></a>
<span class="sourceLineNo">121</span>     * Sets the transaction complete flag to true.<a name="line.121"></a>
<span class="sourceLineNo">122</span>     *<a name="line.122"></a>
<span class="sourceLineNo">123</span>     * @since 2.4.0<a name="line.123"></a>
<span class="sourceLineNo">124</span>     */<a name="line.124"></a>
<span class="sourceLineNo">125</span>    public void completeTransaction() {<a name="line.125"></a>
<span class="sourceLineNo">126</span>        this.transactionComplete = true;<a name="line.126"></a>
<span class="sourceLineNo">127</span>    }<a name="line.127"></a>
<span class="sourceLineNo">128</span><a name="line.128"></a>
<span class="sourceLineNo">129</span>    /**<a name="line.129"></a>
<span class="sourceLineNo">130</span>     * Gets the connection shared by all ManagedConnections in the transaction. Specifically, connection using the same<a name="line.130"></a>
<span class="sourceLineNo">131</span>     * XAConnectionFactory from which the TransactionRegistry was obtained.<a name="line.131"></a>
<span class="sourceLineNo">132</span>     *<a name="line.132"></a>
<span class="sourceLineNo">133</span>     * @return the shared connection for this transaction<a name="line.133"></a>
<span class="sourceLineNo">134</span>     */<a name="line.134"></a>
<span class="sourceLineNo">135</span>    public Connection getSharedConnection() {<a name="line.135"></a>
<span class="sourceLineNo">136</span>        return sharedConnection;<a name="line.136"></a>
<span class="sourceLineNo">137</span>    }<a name="line.137"></a>
<span class="sourceLineNo">138</span><a name="line.138"></a>
<span class="sourceLineNo">139</span>    private Transaction getTransaction() throws SQLException {<a name="line.139"></a>
<span class="sourceLineNo">140</span>        final Transaction transaction = this.transactionRef.get();<a name="line.140"></a>
<span class="sourceLineNo">141</span>        if (transaction == null) {<a name="line.141"></a>
<span class="sourceLineNo">142</span>            throw new SQLException("Unable to enlist connection because the transaction has been garbage collected");<a name="line.142"></a>
<span class="sourceLineNo">143</span>        }<a name="line.143"></a>
<span class="sourceLineNo">144</span>        return transaction;<a name="line.144"></a>
<span class="sourceLineNo">145</span>    }<a name="line.145"></a>
<span class="sourceLineNo">146</span><a name="line.146"></a>
<span class="sourceLineNo">147</span>    /**<a name="line.147"></a>
<span class="sourceLineNo">148</span>     * True if the transaction is active or marked for rollback only.<a name="line.148"></a>
<span class="sourceLineNo">149</span>     *<a name="line.149"></a>
<span class="sourceLineNo">150</span>     * @return true if the transaction is active or marked for rollback only; false otherwise<a name="line.150"></a>
<span class="sourceLineNo">151</span>     * @throws SQLException<a name="line.151"></a>
<span class="sourceLineNo">152</span>     *             if a problem occurs obtaining the transaction status<a name="line.152"></a>
<span class="sourceLineNo">153</span>     */<a name="line.153"></a>
<span class="sourceLineNo">154</span>    public boolean isActive() throws SQLException {<a name="line.154"></a>
<span class="sourceLineNo">155</span>        try {<a name="line.155"></a>
<span class="sourceLineNo">156</span>            final Transaction transaction = this.transactionRef.get();<a name="line.156"></a>
<span class="sourceLineNo">157</span>            if (transaction == null) {<a name="line.157"></a>
<span class="sourceLineNo">158</span>                return false;<a name="line.158"></a>
<span class="sourceLineNo">159</span>            }<a name="line.159"></a>
<span class="sourceLineNo">160</span>            final int status = transaction.getStatus();<a name="line.160"></a>
<span class="sourceLineNo">161</span>            return status == Status.STATUS_ACTIVE || status == Status.STATUS_MARKED_ROLLBACK;<a name="line.161"></a>
<span class="sourceLineNo">162</span>        } catch (final SystemException e) {<a name="line.162"></a>
<span class="sourceLineNo">163</span>            throw new SQLException("Unable to get transaction status", e);<a name="line.163"></a>
<span class="sourceLineNo">164</span>        }<a name="line.164"></a>
<span class="sourceLineNo">165</span>    }<a name="line.165"></a>
<span class="sourceLineNo">166</span><a name="line.166"></a>
<span class="sourceLineNo">167</span>    /**<a name="line.167"></a>
<span class="sourceLineNo">168</span>     * Gets the transaction complete flag to true.<a name="line.168"></a>
<span class="sourceLineNo">169</span>     *<a name="line.169"></a>
<span class="sourceLineNo">170</span>     * @return The transaction complete flag.<a name="line.170"></a>
<span class="sourceLineNo">171</span>     *<a name="line.171"></a>
<span class="sourceLineNo">172</span>     * @since 2.4.0<a name="line.172"></a>
<span class="sourceLineNo">173</span>     */<a name="line.173"></a>
<span class="sourceLineNo">174</span>    public boolean isTransactionComplete() {<a name="line.174"></a>
<span class="sourceLineNo">175</span>        return this.transactionComplete;<a name="line.175"></a>
<span class="sourceLineNo">176</span>    }<a name="line.176"></a>
<span class="sourceLineNo">177</span><a name="line.177"></a>
<span class="sourceLineNo">178</span>    /**<a name="line.178"></a>
<span class="sourceLineNo">179</span>     * Sets the shared connection for this transaction. The shared connection is enlisted in the transaction.<a name="line.179"></a>
<span class="sourceLineNo">180</span>     *<a name="line.180"></a>
<span class="sourceLineNo">181</span>     * @param sharedConnection<a name="line.181"></a>
<span class="sourceLineNo">182</span>     *            the shared connection<a name="line.182"></a>
<span class="sourceLineNo">183</span>     * @throws SQLException<a name="line.183"></a>
<span class="sourceLineNo">184</span>     *             if a shared connection is already set, if XAResource for the connection could not be found in the<a name="line.184"></a>
<span class="sourceLineNo">185</span>     *             transaction registry, or if there was a problem enlisting the connection in the transaction<a name="line.185"></a>
<span class="sourceLineNo">186</span>     */<a name="line.186"></a>
<span class="sourceLineNo">187</span>    public void setSharedConnection(final Connection sharedConnection) throws SQLException {<a name="line.187"></a>
<span class="sourceLineNo">188</span>        if (this.sharedConnection != null) {<a name="line.188"></a>
<span class="sourceLineNo">189</span>            throw new IllegalStateException("A shared connection is already set");<a name="line.189"></a>
<span class="sourceLineNo">190</span>        }<a name="line.190"></a>
<span class="sourceLineNo">191</span><a name="line.191"></a>
<span class="sourceLineNo">192</span>        // This is the first use of the connection in this transaction, so we must<a name="line.192"></a>
<span class="sourceLineNo">193</span>        // enlist it in the transaction<a name="line.193"></a>
<span class="sourceLineNo">194</span>        final Transaction transaction = getTransaction();<a name="line.194"></a>
<span class="sourceLineNo">195</span>        try {<a name="line.195"></a>
<span class="sourceLineNo">196</span>            final XAResource xaResource = transactionRegistry.getXAResource(sharedConnection);<a name="line.196"></a>
<span class="sourceLineNo">197</span>            if (!transaction.enlistResource(xaResource)) {<a name="line.197"></a>
<span class="sourceLineNo">198</span>                throw new SQLException("Unable to enlist connection in transaction: enlistResource returns 'false'.");<a name="line.198"></a>
<span class="sourceLineNo">199</span>            }<a name="line.199"></a>
<span class="sourceLineNo">200</span>        } catch (final IllegalStateException e) {<a name="line.200"></a>
<span class="sourceLineNo">201</span>            // This can happen if the transaction is already timed out<a name="line.201"></a>
<span class="sourceLineNo">202</span>            throw new SQLException("Unable to enlist connection in the transaction", e);<a name="line.202"></a>
<span class="sourceLineNo">203</span>        } catch (final RollbackException e) {<a name="line.203"></a>
<span class="sourceLineNo">204</span>            // transaction was rolled back... proceed as if there never was a transaction<a name="line.204"></a>
<span class="sourceLineNo">205</span>        } catch (final SystemException e) {<a name="line.205"></a>
<span class="sourceLineNo">206</span>            throw new SQLException("Unable to enlist connection the transaction", e);<a name="line.206"></a>
<span class="sourceLineNo">207</span>        }<a name="line.207"></a>
<span class="sourceLineNo">208</span><a name="line.208"></a>
<span class="sourceLineNo">209</span>        this.sharedConnection = sharedConnection;<a name="line.209"></a>
<span class="sourceLineNo">210</span>    }<a name="line.210"></a>
<span class="sourceLineNo">211</span>}<a name="line.211"></a>




























































</pre>
</div>
</body>
</html>
